home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 031a / voredit1.zip / VOREDIT.DOC < prev    next >
Text File  |  1990-12-27  |  47KB  |  1,299 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                VOREDIT (tm)   Program Documentation
  8.  
  9.  
  10.                   Version 1.1
  11.  
  12.                   Copyright (C) 1987, 1990 by
  13.  
  14.                      Voree Software
  15.                      5894 Spring Valley Rd.
  16.                      Burlington, WI  53105
  17.  
  18.                   All Rights Reserved
  19.  
  20.                      Phone:  (414) 763-4522  Voice
  21.                      8 a.m. - 8 p.m.  Central Time
  22.  
  23.                   December 27, 1990
  24.  
  25.  
  26.                A TWO-WINDOW, COMPARING EDITOR
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                               - 1 -
  61.                          TABLE OF CONTENTS
  62.  
  63.  
  64. PURPOSE,  DISCLAIMER   . . . . . . . . . . . . . . . . . . . .  3
  65.  
  66. QUICK START
  67.    Getting Information . . . . . . . . . . . . . . . . . . . .  3
  68.    Editing One File, Two Files . . . . . . . . . . . . . . . .  4
  69.  
  70. SPECIAL OPTIONS  . . . . . . . . . . . . . . . . . . . . . . .  4
  71.  
  72. SPECIAL FEATURES . . . . . . . . . . . . . . . . . . . . . . .  6
  73.  
  74. LIMITATIONS  . . . . . . . . . . . . . . . . . . . . . . . . .  7
  75.  
  76. FUNCTION KEYS
  77.    On Line Help, File Save, File Change, Quit  . . . . . . . .  8
  78.    Comparing Two Files . . . . . . . . . . . . . . . . . . . .  8
  79.    Switching Windows . . . . . . . . . . . . . . . . . . . . .  9
  80.  
  81. KEY NAMES  . . . . . . . . . . . . . . . . . . . . . . . . . .  9
  82.  
  83. NOTATION . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
  84.  
  85. CURSOR MOVEMENT  . . . . . . . . . . . . . . . . . . . . . . . 10
  86.  
  87. VIEW MOVEMENT  . . . . . . . . . . . . . . . . . . . . . . . . 12
  88.  
  89. INSERTING TEXT
  90.    Insert Mode, Overwrite Mode . . . . . . . . . . . . . . . . 12
  91.    Extended Character Set  . . . . . . . . . . . . . . . . . . 13
  92.  
  93. SAMPLE PRINTER CONTROL FILE  . . . . . . . . . . . . . . . . . 14
  94.  
  95. EDITING COMMANDS . . . . . . . . . . . . . . . . . . . . . . . 14
  96.  
  97. QUERY LINE EDITING . . . . . . . . . . . . . . . . . . . . . . 16
  98.  
  99. BLOCK COMMANDS
  100.    Set Block, Move, Copy, Delete . . . . . . . . . . . . . . . 17
  101.    Printing  . . . . . . . . . . . . . . . . . . . . . . . . . 17
  102.    File Write, File Read, Find Block . . . . . . . . . . . . . 18
  103.  
  104. SEARCH COMMANDS
  105.    Find, Find and Replace  . . . . . . . . . . . . . . . . . . 18
  106.    Options . . . . . . . . . . . . . . . . . . . . . . . . . . 19
  107.  
  108. TEXT FORMATTING COMMANDS
  109.    Paragraph Reformat, Word Move . . . . . . . . . . . . . . . 19
  110.  
  111. SETUP COMMANDS
  112.    Show All Differences, Margins, Word Wrap  . . . . . . . . . 20
  113.    Insert Key  . . . . . . . . . . . . . . . . . . . . . . . . 21
  114.  
  115. FILE AND WINDOW CONTROL
  116.    Save, Change  . . . . . . . . . . . . . . . . . . . . . . . 21
  117.    Quit, Exit, Two Windows . . . . . . . . . . . . . . . . . . 22
  118.  
  119.                               - 2 -
  120. PURPOSE
  121.  
  122.  
  123.      This text editor program, called VorEdit, was written by
  124. James D. Hajicek. It is intended to be a simple editor using
  125. basically the same control key commands employed by the WordStar
  126. word processing program and by many popular editors, and may be
  127. used to edit or to create pure ASCII text files. It runs on an
  128. IBM PC or compatible computer using PC-DOS or MS-DOS version 2.0
  129. or greater.
  130.  
  131.      The most unique feature of VorEdit is the implementation of
  132. two-window editing, which is intended to allow two text files to
  133. be compared and the differences easily observed.
  134.  
  135.      VorEdit is also useful for simple editing tasks, such as
  136. creating and revising .BAT files. It may also be used to create
  137. printer control files, because the escape character, as well as
  138. other special characters may be entered into text files.
  139.  
  140.  
  141.  
  142.  
  143. DISCLAIMER
  144.  
  145.  
  146.      This program has been carefully written and tested. However,
  147. the user of the program is solely responsible for determining if
  148. it is useful and adequate for the intended purpose.
  149.  
  150.      No warranty is expressed or implied.
  151.  
  152.  
  153.  
  154.  
  155. QUICK START
  156.  
  157.  
  158. *** GETTING INFORMATION ***
  159.  
  160.      Information about VorEdit may be obtained from the DOS
  161. prompt by using the following command:
  162.  
  163.    VOREDIT
  164.  
  165. with no other parameters. This provides a quick reference to a
  166. few special options which may be used on the DOS command line.
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.                               - 3 -
  179. *** EDITING ONE FILE ***
  180.  
  181.      In normal use, the text editor is started from the DOS
  182. prompt with the following command:
  183.  
  184.    VOREDIT filename
  185.  
  186. where "filename" is the name of a pure ASCII text file. The
  187. following function keys are fundamental:
  188.  
  189.   F1  --  Displays a quick help screen.
  190.  
  191.   F2  --  Saves the text file.
  192.  
  193.   F3  --  Allows the user to select a different file to edit.
  194.  
  195.   F4  --  Quits the editor. By itself this does not save the
  196.           file.
  197.  
  198.   F9  --  Opens a second window with another file.
  199.  
  200.  
  201.      While editing, the upper right-hand corner of the window
  202. frame displays the current line and column position of the
  203. cursor.
  204.  
  205.  
  206.  
  207.  
  208. *** EDITING TWO FILES ***
  209.  
  210.      Two files may be edited simultaneously using the following
  211. command:
  212.  
  213.    VOREDIT filename1 filename2
  214.  
  215. In this case, the following function keys will be especially
  216. important in addition to the three mentioned above:
  217.  
  218.   F7  --  Compares the two files from the top.
  219.  
  220.   F8  --  Compares the two files onward from the current line of
  221.           each.
  222.  
  223.   F9  --  Changes the active window from one file to the other.
  224.  
  225.  
  226.  
  227.  
  228. SPECIAL OPTIONS
  229.  
  230.  
  231.      There are several options which may be also used on the
  232. command line. They must be separated from the file names and from
  233. each other by a space, but may be placed anywhere on the command
  234. line after the VOREDIT program name. See the example on page 14.
  235. Either upper or lower case letters may be used in these options.
  236.  
  237.                               - 4 -
  238.   +ALL     Shows all differences on compared lines. Otherwise,
  239.            when two files are compared, the first difference
  240.            is highlighted up until a character is found which
  241.            is not different, and further differences are not
  242.            highlighted.
  243.  
  244.            This option may also be turned on and off while
  245.            editing with the Ctrl-O-A keys.
  246.  
  247.   +JAM     Causes the paragraph reformat commands, Ctrl-B and
  248.            Alt-B, to compress all groups of multiple spaces to a
  249.            single space.
  250.  
  251.            This is a stronger, more rigorous method of formatting
  252.            a paragraph, but may be inconvenient because two
  253.            spaces after a period will be changed to one, etc.
  254.  
  255.   -BEL     Turns off the bell on errors. Otherwise, in the event
  256.            of a DOS error or an attempt to move the cursor beyond
  257.            column 10,000, the bell will be sounded once.
  258.  
  259.   -CLN     Prevents the cleanup at the end of lines. Otherwise,
  260.            when a line is modified in any way, any spaces at the
  261.            end of the line are removed, and any irregular line
  262.            ending, such as a lone CR (carriage-return) or a lone
  263.            LF (line-feed) is converted to the standard CR LF
  264.            pair.
  265.  
  266.   -BAK     Prevents the creation of a backup file. Otherwise,
  267.            when a save is made, the original file is renamed
  268.            with a .BAK extension. Having the backup file is
  269.            usually desirable, allowing the user to recover the
  270.            original unaltered file if necessary.
  271.  
  272.   -EOF     Prevents the addition to the end of the text file of
  273.            an end-of-file character when a save is made. Use
  274.            of this option might be desired, for example, if a
  275.            printer control file is being created which will be
  276.            sent to the printer from the DOS prompt with a COPY /B
  277.            command. Such a file may contain escape sequences, but
  278.            an extra end-of-file character (Ctrl-Z, ASCII 26)
  279.            might be undesirable.
  280.  
  281.   +HID     Causes the revised file to be created as a hidden
  282.            file. The old file, renamed with a .BAK extension,
  283.            always retains the attributes of the original file.
  284.  
  285.  
  286.      Incidentally, VorEdit will edit a hidden file, a system
  287. file, or a read-only file, whether the +HID option is used or
  288. not. Only the renamed .BAK file retains the original attributes.
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.                               - 5 -
  297. SPECIAL FEATURES
  298.  
  299.  
  300.      VorEdit was created for comparing two different text files
  301. to easily identify differences. When used as originally intended,
  302. two different people enter the text of an important document,
  303. with each making occasional typing mistakes. VorEdit is then
  304. used to reconcile the two different versions of the document,
  305. correcting the errors in both until they are equal. This gives a
  306. version which is virtually error free.
  307.  
  308.      The editor has been used extensively in the above
  309. application. In addition, it has been found to be a useful
  310. programming tool, as old and new versions of a computer program
  311. may be compared to reveal the changes which were made. Also, when
  312. two different programmers work independently on the same source
  313. code file, the two resulting versions may be merged by comparing
  314. them to locate all new work, using the block copy from one to the
  315. other until both are equal.
  316.  
  317.      There is no limitation on line length. Lines as long as the
  318. entire file size are correctly processed. However, as a practical
  319. matter of display speed, in this version 1.1 the cursor is not
  320. allowed to increase beyond column 10,000. The viewing of long
  321. lines is limited to this extent.
  322.  
  323.      When the cursor moves beyond column 78, the view shifts to
  324. the right, and the beginning of the lines are no longer visible
  325. within the window. To remind the user of this, the left border of
  326. the window changes from a double line to a single line, and the
  327. corners of the window straighten out.
  328.  
  329.      Any character in the extended character set from ASCII 0 to
  330. ASCII 255 may be entered into a file, including isolated CR, LF,
  331. and EOF characters, which are ASCII 13, 10, and 26 respectively.
  332. The CR LF pair is of course also generated with the Enter key
  333. (when in insert mode).
  334.  
  335.      VorEdit was not developed with the intention of editing
  336. binary files, but it is robust enough to view any file whatever.
  337. Any of four conditions are interpreted as the end of a line:
  338.  
  339.  1. A CR LF pair, ASCII 13 and ASCII 10.
  340.  2. A CR (carriage-return) alone followed by any character other
  341.     than a LF.
  342.  3. An LF (line-feed) alone preceded by any character other than
  343.     a CR.
  344.  4. An EOF (end-of-file) character, ASCII 26, whether at the end
  345.     of a file or in the middle.
  346.  
  347.      The current version 1.1 will always remove extra EOF
  348. characters from the end of the file, but by using the -EOF and
  349. -CLN options, and working in overwrite mode or very carefully in
  350. insert mode, in most cases any text within a binary file may be
  351. modified with VorEdit and the file correctly saved.
  352.  
  353.  
  354.  
  355.                               - 6 -
  356.      VorEdit is definitely useful for creating printer control
  357. files, which may contain escape sequences. The escape character
  358. itself may be entered into a file using the Ctrl-P-[ or the
  359. Ctrl-P-Esc keys. Such files may be sent to a printer with a DOS
  360. COPY /B command. See the "Example Printer Control File"
  361. discussion below for more information.
  362.  
  363.      The help screens are available at all times on the Ctrl-J or
  364. the F1 keys. No extra files are needed to display these screens.
  365. The help screens are not intended to replace a manual, but will
  366. remind the user of the appropriate keys to use to perform a
  367. desired function.
  368.  
  369.  
  370.  
  371.  
  372. LIMITATIONS
  373.  
  374.  
  375.      The files to be edited are limited in size to about 65,000
  376. bytes each. This and other limitations may be overcome in future
  377. versions.
  378.  
  379.      There is no undo function. Any text which is deleted is
  380. gone. Until the next version is released, which is planned to
  381. include a delete-undo function on the Ctrl-U key, it is best to
  382. save your work frequently with the F2 key. Of course, any deleted
  383. text may be recovered by opening a second window containing the
  384. same file, or a .BAK version of it, and performing a block copy
  385. to recover the deleted text. The Ctrl-U key, as well as the Esc
  386. key, may be used in many places to cancel an operation which is
  387. in progress.
  388.  
  389.      The tab character, ASCII 9, is not expanded into spaces on
  390. the screen. It is instead treated like any other character and
  391. is displayed with its natural symbol in the IBM PC extended
  392. character set, which looks like a small hollow circle. The Tab
  393. key and the Shift-Tab key do move the move the cursor right
  394. and left to tab positions on the screen, but no characters are
  395. inserted into the file being edited.
  396.  
  397.      The options on search functions are somewhat limited in this
  398. version. These will be expanded in future versions.
  399.  
  400.      Any character in the extended character set from ASCII 0 to
  401. ASCII 255 may be entered into a search string with the exception
  402. of individual CR, LF, and EOF characters, which are ASCII 13, 10,
  403. and 26 respectively. The next version will allow these as well.
  404.  
  405.      The color choices for the border, notices, text, block text,
  406. found text, and help screen are fixed. The keyboard configuration
  407. is also fixed. It is planned that the next version will include a
  408. configuration program to customize the colors and the use of the
  409. control, alternate, and function keys.
  410.  
  411.  
  412.  
  413.  
  414.                               - 7 -
  415. FUNCTION KEYS
  416.  
  417.  
  418.      The use of the function keys is nonstandard. In VorEdit they
  419. are used as follows:
  420.  
  421.  
  422.   F1  --  Displays a quick help screen. If F1 is pressed again, a
  423.           second help screen is displayed. Press any other key to
  424.           return to normal editing.
  425.  
  426.           For compactness in these displays, the Ctrl key is
  427.           represented by ^ , the Alt key is represented by @ ,
  428.           and the shift key is represented by # in the help
  429.           screens only.
  430.  
  431.   F2  --  Saves the text file without leaving the editor. The
  432.           old file is given a .BAK extension. If there are two
  433.           windows, only the file in the active window is saved.
  434.           The active window is the window in which the cursor
  435.           appears.
  436.  
  437.   F3  --  Prompts for the name of a different file to edit. If
  438.           the file has been altered without being saved, you
  439.           will be asked if you are sure you want to abandon your
  440.           alterations. If you wish to quit with no change to the
  441.           original file, answer "y" or "yes".
  442.  
  443.   F4  --  Quits the editor and returns to DOS. If the file has
  444.           been altered without being saved, you will be asked if
  445.           you are sure you want to quit. If you wish to quit with
  446.           no change to the original file, answer "y" or "yes".
  447.  
  448.           When two files are being edited, this closes the active
  449.           window and makes the other window active.
  450.  
  451.   F5  --  Switches the character at the cursor from upper case to
  452.           lower case or vice versa. The single and double quote
  453.           marks are switched. The period, comma, semicolon, and
  454.           colon are switched. The parenthesis, square bracket,
  455.           and curly bracket are switched. The forward and
  456.           backward slash are switched.
  457.  
  458.   F6  --  Swaps the character at the cursor with the one
  459.           immediately following.
  460.  
  461.   F7  --  When there are two windows, this compares the two files
  462.           starting from the top. If the files agree, a message at
  463.           the top of the screen will indicate that no differences
  464.           were found. If the files do not agree, the two windows
  465.           will show the first difference highlighted.
  466.  
  467.   F8  --  When there are two windows, this compares the two files
  468.           starting from the current line of each. The current
  469.           lines are the line on which the cursor appears and the
  470.           line on which the cursor would appear if the other
  471.           window were active.
  472.  
  473.                               - 8 -
  474.   F9  --  When there are two windows, this switches which window
  475.           is active. The cursor is moved from one window to the
  476.           other. The position of the cursor in the window which
  477.           becomes inactive is remembered.
  478.  
  479.           When only one file is being edited, this allows the
  480.           user to open a second window. The user is prompted for
  481.           the name of the second file.
  482.  
  483.  F10  --  Moves the text up and down within the window. The
  484.           position of the cursor relative to the text does not
  485.           change. If the cursor is not at the top of the window,
  486.           the cursor moves to the top of the window, taking
  487.           the text with it. If the cursor is at the top of the
  488.           window, the cursor moves to the bottom of the window,
  489.           or down as far as possible, taking the text with it.
  490.  
  491.  
  492.  
  493.  
  494. KEY NAMES
  495.  
  496.  
  497.      The following keys are located to the right of the main
  498. portion of the keyboard.  The numeric keypad at the right side of
  499. the keyboard can also be used for these keys, provided that the
  500. Number Lock is turned off.  On many keyboards, the numeric keypad
  501. provides the only location for these keys.
  502.  
  503.   UpArrow       These keys usually have arrows on them.
  504.   DownArrow
  505.   LeftArrow
  506.   RightArrow
  507.  
  508.   Home
  509.   End
  510.  
  511.   PageUp        May be labeled "Pg Up".
  512.   PageDown      May be labeled "Pg Dn".
  513.  
  514.   Delete        May be labeled "Del".
  515.   Insert        May be labeled "Ins".
  516.  
  517.  
  518.      The following keys are given names in this document, even
  519. though they may be identified by symbols on actual keyboards:
  520.  
  521.   BackSpace     This key is usually located at the upper right
  522.                 corner of the main portion of the keyboard, just
  523.                 above the Enter key. It usually has a backward
  524.                 arrow on it. It should not be confused with the
  525.                 LeftArrow key.
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.                               - 9 -
  533.   Tab           This key is usually located directly to the left
  534.                 of the Q key. It usually has two arrows on it,
  535.                 an arrow to the left, indicating a backward tab
  536.                 function when the shift key is pressed, and an
  537.                 arrow to the right, indicating a forward tab
  538.                 function.
  539.  
  540.  
  541.  
  542.  
  543. NOTATION
  544.  
  545.  
  546.      The following notation is used in the sections below:
  547.  
  548.  Ctrl-A     --  This indicates that the "A" key should be pressed
  549.                 while the "Control" key is being held down.
  550.  
  551.  Ctrl-Q-R   --  This indicates that the "Q" key should be pressed
  552.                 momentarily while the "Control" key is being held
  553.                 down, and that then the "R" key should be pressed
  554.                 momentarily (with or without the "Control" key).
  555.  
  556.  Alt-B      --  This indicates that the "B" key should be pressed
  557.                 while the "Alternate" key is being held down.
  558.  
  559.  Shift-Tab  --  This indicates that the "Tab" key should be
  560.                 pressed while the "Shift" key is being held down.
  561.  
  562.  
  563.  
  564.  
  565. CURSOR MOVEMENT
  566.  
  567.  
  568.      The motion of the cursor is limited to the number of lines
  569. which have been created in the text file. That is, the cursor can
  570. not be moved down past the last line of the file.
  571.  
  572.   Ctrl-S  or  LeftArrow   --  Moves the cursor backward.
  573.   Ctrl-D  or  RightArrow  --  Moves the cursor forward.
  574.   Ctrl-E  or  UpArrow     --  Moves the cursor up one line.
  575.   Ctrl-X  or  DownArrow   --  Moves the cursor down one line.
  576.  
  577.      Note that the cursor movement using the Ctrl method is
  578. accomplished with four keys which form a diamond on the keyboard:
  579.  
  580.           E
  581.         S   D
  582.           X
  583.  
  584.      For many touch typists, using the control keys to move the
  585. cursor is more effective than using the arrow keys, as the cursor
  586. may be moved without taking the hands off of the keyboard. The
  587. above diamond makes it easy to remember the direction controlled
  588. by each key.
  589.  
  590.  
  591.                              - 10 -
  592.   Ctrl-I  or  Tab         --  Moves the cursor forward until
  593.                               it is at an exact multiple of 5
  594.                               characters from the beginning of
  595.                               the line. This will place the
  596.                               cursor at column 6, 11, 16, etc.
  597.  
  598.               Shift-Tab   --  Moves the cursor backward until
  599.                               it is at an exact multiple of 5
  600.                               characters from the beginning of
  601.                               the line. This will place the
  602.                               cursor at column 1, 6, 11, etc.
  603.  
  604.   Ctrl-R  or  PageUp      --  Moves the cursor relative to the
  605.                               text up by one screen (10 or 22
  606.                               lines).
  607.  
  608.   Ctrl-C  or  PageDown    --  Moves the cursor relative to the
  609.                               text down one screen (10 or 22
  610.                               lines).
  611.  
  612.   Ctrl-A  or  Ctrl-LeftArrow   --  Moves the cursor backward
  613.                                    one word.
  614.  
  615.   Ctrl-F  or  Ctrl-RightArrow  --  Moves the cursor forward
  616.                                    one word.
  617.  
  618.   Ctrl-Q-S  or  Home      --  Moves the cursor to the beginning
  619.                               of the line.
  620.  
  621.   Ctrl-Q-D  or  End       --  Moves the cursor to the end
  622.                               of the line.
  623.  
  624.   Ctrl-Q-E  or  Ctrl-Home      --  Moves the cursor to the
  625.                                    top of the screen.
  626.  
  627.   Ctrl-Q-X  or  Ctrl-End       --  Moves the cursor to the
  628.                                    bottom of the screen.
  629.  
  630.   Ctrl-Q-R  or  Ctrl-PageUp    --  Moves the cursor to the
  631.                                    beginning of the file.
  632.  
  633.   Ctrl-Q-C  or  Ctrl-PageDown  --  Moves the cursor to the
  634.                                    end of the file.
  635.  
  636.   Ctrl-Q-B                --  Moves the cursor to the beginning
  637.                               of a marked block. See Ctrl-K-B.
  638.  
  639.   Ctrl-Q-K                --  Moves the cursor to the end of a
  640.                               marked block. See Ctrl-K-K.
  641.  
  642.   Ctrl-Q-W                --  Moves the cursor up at least one
  643.                               line and on up to the beginning of
  644.                               the paragraph.
  645.  
  646.   Ctrl-Q-Z                --  Moves the cursor down to the
  647.                               beginning of the next paragraph.
  648.  
  649.  
  650.                              - 11 -
  651.   Alt-J                   --  Jump to a specified line. The user
  652.                               is asked for the desired line
  653.                               number.
  654.  
  655.                               The operation may be canceled with
  656.                               a Ctrl-U or the Esc key.
  657.  
  658.  
  659.  
  660.  
  661. VIEW MOVEMENT
  662.  
  663.  
  664.      Although the cursor movement can affect the portion of the
  665. text which is being viewed in the window, the following functions
  666. affect only the portion of text which is being viewed. In other
  667. words, the text moves, but the cursor keeps its position within
  668. the text.
  669.  
  670.      The motion of these functions is limited by the beginning
  671. and end of the file, and by the requirement that the cursor must
  672. remain within the window.
  673.  
  674.   Ctrl-W   --  The text view is moved up one line.
  675.  
  676.   Ctrl-Z   --  The text view is moved down one line.
  677.  
  678.   F10      --  The text view is alternately moved up and down
  679.                so that the cursor moves from the top to the
  680.                bottom of the window.
  681.  
  682.  
  683.  
  684.  
  685. INSERTING TEXT
  686.  
  687.  
  688.      When editing in "insert" mode, the new character is inserted
  689. at the location of the cursor, and the position of the cursor is
  690. moved ahead one space, together with any text on the line from
  691. the position of the cursor rightward.
  692.  
  693.      When editing in "overwrite" mode, the new character replaces
  694. any character which is currently at the location of the cursor,
  695. and the position of the cursor is moved ahead one space. This
  696. is useful at times, but also can also result in accidental
  697. destruction of desired text.
  698.  
  699.      The initial mode of the editor is "insert" mode. In order
  700. to put the editor into "overwrite" mode, two steps are necessary.
  701. The Ins key must be turned on with the Ctrl-O-I keys, and then
  702. either the Ctrl-V or the Ins key must be pressed.
  703.  
  704.      Unless the -CLN option was used on the DOS command line,
  705. VorEdit does not enter spaces at the end of a line. If a line is
  706. altered in any way, any previously existing spaces at the end of
  707. the line will be removed.
  708.  
  709.                              - 12 -
  710.   Alpha-Numeric Keys  --  Any of the standard alphabetic or
  711.                           numeric keys may be used for entering
  712.                           characters. This will allow the
  713.                           generation of any character from
  714.                           32 to 95.
  715.  
  716.   Alt-Numeric-KeyPad  --  Any character of the extended character
  717.                           set, from 32 to 255, may be inserted
  718.                           into the text by holding down the Alt
  719.                           key while entering the number of the
  720.                           desired character on the numeric keypad
  721.                           on the right side of the keyboard.
  722.  
  723.   Ctrl-P-             --  Any of the control characters, from
  724.                           0 to 31, may be inserted into the text
  725.                           by using Ctrl-P followed by another
  726.                           key.
  727.  
  728.                           See the following list of these control
  729.                           characters.
  730.  
  731.   Ctrl-P-2    --   0  Null. Looks like a space.
  732.   Ctrl-P-A    --   1
  733.   Ctrl-P-B    --   2
  734.   Ctrl-P-C    --   3
  735.   Ctrl-P-D    --   4
  736.   Ctrl-P-E    --   5
  737.   Ctrl-P-F    --   6
  738.   Ctrl-P-G    --   7  Bell.
  739.   Ctrl-P-H    --   8  Back-Space. Used for a printer overstrike.
  740.   Ctrl-P-I    --   9  Tab.
  741.   Ctrl-P-J    --  10  Line-Feed. A new line in VorEdit.
  742.   Ctrl-P-K    --  11
  743.   Ctrl-P-L    --  12  Form-Feed.
  744.   Ctrl-P-M    --  13  Carriage-Return. A new line in VorEdit.
  745.   Ctrl-P-N    --  14
  746.   Ctrl-P-O    --  15
  747.   Ctrl-P-P    --  16
  748.   Ctrl-P-Q    --  17
  749.   Ctrl-P-R    --  18
  750.   Ctrl-P-S    --  19
  751.   Ctrl-P-T    --  20
  752.   Ctrl-P-U    --  21
  753.   Ctrl-P-V    --  22
  754.   Ctrl-P-W    --  23
  755.   Ctrl-P-X    --  24
  756.   Ctrl-P-Y    --  25
  757.   Ctrl-P-Z    --  26  End-Of-File. A new line in VorEdit.
  758.   Ctrl-P-[    --  27  Escape.
  759.   Ctrl-P-\    --  28
  760.   Ctrl-P-]    --  29
  761.   Ctrl-P-6    --  30
  762.   Ctrl-P -    --  31
  763.  
  764.  
  765.  
  766.  
  767.  
  768.                              - 13 -
  769.      The Tab character, ASCII 9, may also be entered with
  770. Ctrl-P-Tab, but the Ctrl key must be released before the Tab is
  771. pressed. The Escape character, ASCII 27, may also be entered with
  772. Ctrl-P-Esc.
  773.  
  774.  
  775.  
  776.  
  777. SAMPLE PRINTER CONTROL FILE
  778.  
  779.  
  780.      As an example of how these special characters might be used,
  781. suppose that the objective is to create a file to send a new page
  782. sequence to a printer. First open a new file FORMFEED.PRN with
  783. the following command:
  784.  
  785.    VOREDIT -CLN -EOF FORMFEED.PRN
  786.  
  787. Then enter a CR (carriage-return) and a FF (form-feed) into the
  788. new file with the Ctrl-P-M and Ctrl-P-L keys. Save the file with
  789. the F2 key. The new file will have a byte length of 2, containing
  790. an ASCII 13 and an ASCII 12. This file may be sent to the printer
  791. with a command like one of the following:
  792.  
  793.    COPY /B FORMFEED.PRN PRN
  794.  
  795.    COPY /B FORMFEED.PRN LPT1:
  796.  
  797.    COPY /B FORMFEED.PRN COM1:
  798.  
  799. The exact form of the destination used will depend upon the port
  800. which the printer is connected to. The PRN device is ordinarily
  801. the same as LPT1.
  802.  
  803.      The purpose of the carriage-return in the above example is
  804. to guarantee that the printer horizontal position is moved back
  805. to the beginning of the line, as some printers use the form-feed
  806. to eject a page, but do not automatically reset the horizontal
  807. position.
  808.  
  809.  
  810.  
  811.  
  812. EDITING COMMANDS
  813.  
  814.  
  815.   Ctrl-M  or  Enter      --  When editing in "insert" mode, this
  816.                              creates a new line with any text
  817.                              from the position of the cursor
  818.                              rightward. The cursor moves to the
  819.                              beginning of the new line.
  820.  
  821.                              When editing in "overwrite" mode,
  822.                              this moves the cursor to the
  823.                              beginning of the next line, but will
  824.                              not create a new line.
  825.  
  826.  
  827.                              - 14 -
  828.   Ctrl-N                 --  Creates a new line with the text
  829.                              from the position of the cursor
  830.                              rightward, but the cursor remains
  831.                              at the end of the old line.
  832.  
  833.   Ctrl-H  or  BackSpace  --  Deletes the character before the
  834.                              cursor, and the cursor is moved one
  835.                              space to the left.
  836.  
  837.                              When in "insert" mode, the rest of
  838.                              the line from the position of the
  839.                              cursor rightward is moved with the
  840.                              cursor one space to the left.
  841.  
  842.                              When in "insert" mode, if the cursor
  843.                              is at the beginning of a line, the
  844.                              entire line is moved up to the end
  845.                              of the line above it, together with
  846.                              the cursor.
  847.  
  848.                              When in "overwrite" mode, if the
  849.                              cursor is at the beginning of a
  850.                              line, the cursor is moved up to the
  851.                              end of the line above it, but the
  852.                              text itself does not move.
  853.  
  854.   Ctrl-G  or  Delete     --  Deletes the character at the cursor
  855.                              position. The rest of the line,
  856.                              rightward from the position of the
  857.                              cursor, is moved one space to the
  858.                              left.
  859.  
  860.                              If the cursor is at or past the end
  861.                              of a line, the following line will
  862.                              be pulled up to the cursor position.
  863.  
  864.   Ctrl-T                 --  Deletes all characters on the same
  865.                              line as the cursor from the cursor
  866.                              to the beginning of the next word.
  867.  
  868.   Ctrl-Y                 --  Deletes the entire line which the
  869.                              cursor is on. The lines below the
  870.                              cursor all move up to fill the gap.
  871.  
  872.   Ctrl-Q-Y               --  Deletes all characters on the same
  873.                              line as the cursor from the cursor
  874.                              to the end of the line.
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.                              - 15 -
  887. QUERY LINE EDITING
  888.  
  889.  
  890.      When VorEdit is prompting for special input, such as a
  891. filename, a number, a yes/no answer, or search strings, a query
  892. line appears at the top of the active window. The user then may
  893. use some of the above commands to edit the desired input.
  894.  
  895.      If the parameter which is being queried already has a value,
  896. this value will appear in the query line when it first appears.
  897. This is a default value for the parameter, and may be selected
  898. with the Enter key, or it may be edited before being selected.
  899. However, if an alpha-numeric key is pressed before the cursor is
  900. moved, the default value disappears and is completely replaced
  901. with the new input. If it is desired to modify the old value
  902. rather than to replace it, begin by moving the cursor in some
  903. way.
  904.  
  905.      Query line editing is always performed in "insert" mode,
  906. even if the regular editing is set to "overwrite" mode.
  907.  
  908.  
  909.   Alpha-Numeric Keys      --  Any of the standard alphabetic or
  910.                               numeric keys.
  911.  
  912.   Alt-Numeric-KeyPad      --  Any character of the extended
  913.                               character set, from 32 to 255.
  914.  
  915.   Ctrl-P-                 --  The characters of the extended
  916.                               character set, from 0 to 31, may
  917.                               be inserted into the text by using
  918.                               Ctrl-P followed by another key,
  919.                               as in normal editing, with the
  920.                               exception of LF, CR, and EOF
  921.                               which are ASCII 10, 13, and 26,
  922.                               respectively.
  923.  
  924.   Ctrl-S  or  LeftArrow   --  Moves the cursor backward.
  925.  
  926.   Ctrl-D  or  RightArrow  --  Moves the cursor forward.
  927.  
  928.               Home        --  Moves the cursor to the beginning
  929.                               of the query line input.
  930.  
  931.               End         --  Moves the cursor to the end
  932.                               of the query line input.
  933.  
  934.   Ctrl-H  or  BackSpace   --  Deletes the character before the
  935.                               cursor, and the cursor is moved one
  936.                               space to the left.
  937.  
  938.   Ctrl-G  or  Delete      --  Deletes the character at the cursor
  939.                               position.
  940.  
  941.   Ctrl-M  or  Enter       --  Accepts the query input.
  942.  
  943.  
  944.  
  945.                              - 16 -
  946.   Ctrl-U  or  Esc         --  Cancels the operation associated
  947.                               with the query. A parameter keeps
  948.                               its old value.
  949.  
  950.  
  951.  
  952.  
  953. BLOCK COMMANDS
  954.  
  955.  
  956.      Certain operations are performed on a marked block of text.
  957. A marked block will appear on the screen in a different color
  958. than the normal text.
  959.  
  960.      There can be at most one block beginning, and at most one
  961. block end. If the block end is after the block beginning, and
  962. is in the same window as the block beginning, the block becomes
  963. visible and is operative.
  964.  
  965.  
  966.   Ctrl-K-B  --  Mark Block Beginning.
  967.  
  968.   Ctrl-K-K  --  Mark Block End. The block does not include the
  969.                 position of the cursor at the end of the block.
  970.  
  971.   Ctrl-K-H  --  Hide Block. If a block is marked and visible,
  972.                 the marked block is made invisible and
  973.                 inoperative. If the marked block is invisible,
  974.                 it is made visible and operative.
  975.  
  976.   Ctrl-K-C  --  Block Copy. The marked block is inserted into
  977.                 the text at the position of the cursor. The new
  978.                 location of the text becomes the marked block.
  979.  
  980.                 This operation may also be performed between two
  981.                 windows.
  982.  
  983.   Ctrl-K-V  --  Block Move. The marked block is inserted into the
  984.                 text at the position of the cursor, and deleted
  985.                 from the old location. The new location of the
  986.                 text becomes the marked block.
  987.  
  988.                 This operation may also be performed between two
  989.                 windows.
  990.  
  991.   Ctrl-K-Y  --  Block Delete. The marked block is deleted.
  992.  
  993.   Ctrl-K-P  --  Block Print. The marked block is sent to the
  994.                 printer device PRN.
  995.  
  996.                 If there is no marked block, the entire file is
  997.                 sent to the printer, followed by a form-feed.
  998.  
  999.                 See the Ctrl-O-L setup for defining a left margin
  1000.                 for printing.
  1001.  
  1002.  
  1003.  
  1004.                              - 17 -
  1005.   Ctrl-K-W  --  Block Write File. The marked block is written
  1006.                 out to a specified filename. Unless the -EOF
  1007.                 option has been used on the DOS command line,
  1008.                 the created file will be ended with one EOF
  1009.                 character.
  1010.  
  1011.                 If there is no marked block, the entire file
  1012.                 is written out to the specified filename.
  1013.  
  1014.                 If a file with the specified filename already
  1015.                 exists, you will be asked if you want to
  1016.                 overwrite the old file. A backup .BAK file is
  1017.                 not created.
  1018.  
  1019.   Ctrl-K-R  --  Block Read File. A specified file is inserted
  1020.                 into the text at the position of the cursor.
  1021.                 The inserted text becomes the marked block.
  1022.  
  1023.   Ctrl-Q-B  --  Find Block Begin. The cursor is moved to the
  1024.                 block beginning.
  1025.  
  1026.   Ctrl-Q-K  --  Find Block End. The cursor is moved to the block
  1027.                 end.
  1028.  
  1029.  
  1030.  
  1031.  
  1032. SEARCH COMMANDS
  1033.  
  1034.  
  1035.      The following commands allow the user to find a text string
  1036. within the file. In this version, the letters of the found string
  1037. must match the search string exactly, upper case and lower case
  1038. exactly the same. Also, the search string may not include a
  1039. carriage-return, a line-feed, or an end-of-file mark. Other
  1040. control characters and extended characters may be inserted into
  1041. the search string in the usual way.
  1042.  
  1043.  
  1044.   Ctrl-Q-F  --  String Find. The user is asked for the search
  1045.                 string and for options. The allowable find
  1046.                 options are G, W, and X.
  1047.  
  1048.   Ctrl-Q-A  --  String Find and Replace. The user is asked for
  1049.                 the search string, for the replacement string,
  1050.                 and for options. The allowable find and replace
  1051.                 options are G, W, X, Q, and N.
  1052.  
  1053.   Ctrl-L    --  Repeat. The last operation is repeated. If the
  1054.                 global G option has been specified, the operation
  1055.                 is resumed from the current position of the
  1056.                 cursor, not from the top of the file.
  1057.  
  1058.   Ctrl-U  or  Esc  --  Cancel. During query input, the operation
  1059.                        may be stopped before it has begun. During
  1060.                        a global operation, it may be aborted.
  1061.  
  1062.  
  1063.                              - 18 -
  1064.      The options which are used for a search command are
  1065. remembered, and are given as the default options the next time
  1066. that command is given. The Find options and the Find and Replace
  1067. options are remembered separately.
  1068.  
  1069.  
  1070.    Option           Description
  1071.  
  1072.      G        Global. Start at the top of the file, and do the
  1073.               entire file.
  1074.  
  1075.      W        Whole Words. The search string must match with no
  1076.               other letters before or after the found string.
  1077.               Spaces, numbers, punctuation, and other special
  1078.               characters are allowed before and after the found
  1079.               string.
  1080.  
  1081.      X        Exact Words. The search string must match with no
  1082.               other characters before or after the found string.
  1083.               Only true spaces, the beginning of the line, and
  1084.               the end of the line are allowed before and after
  1085.               the found string.
  1086.  
  1087.      Q        Quick-ask. A replace operation will require only
  1088.               a single "Y" or "y" key press to perform the
  1089.               operation. Any other key press will be interpreted
  1090.               as a "No."
  1091.  
  1092.      N        No-ask. A replace operation will be performed
  1093.               without asking the user. If the global G option
  1094.               is also specified, the replacements will proceed
  1095.               through the entire file, with no user input
  1096.               required.
  1097.  
  1098.  
  1099.  
  1100.  
  1101. TEXT FORMATTING COMMANDS
  1102.  
  1103.  
  1104.   Ctrl-B    --  Reformats a paragraph from the line the cursor
  1105.                 is on to the end of the paragraph. The cursor is
  1106.                 moved to the end of the paragraph.
  1107.  
  1108.                 The end of the paragraph is defined as either the
  1109.                 end of the file, the next blank line, or the next
  1110.                 line starting with a space.
  1111.  
  1112.   Alt-B     --  Reformats a paragraph without changing the line
  1113.                 which the cursor is on. However, the cursor will
  1114.                 be moved to the beginning of the line.
  1115.  
  1116.   Alt-W     --  Moves a word from the end of the current line
  1117.                 to the beginning of the following line.
  1118.  
  1119.                 This is useful when manually reformatting a
  1120.                 paragraph.
  1121.  
  1122.                              - 19 -
  1123. SETUP COMMANDS
  1124.  
  1125.  
  1126.   Ctrl-O-A  --  Turns the show-all-differences "on" and "off".
  1127.  
  1128.                 When "on", all differences on compared lines are
  1129.                 highlighted.
  1130.  
  1131.                 When "off", the first difference is highlighted
  1132.                 up until a character which is not different, and
  1133.                 further differences are not highlighted.
  1134.  
  1135.                 The initial condition is "off", but may also be
  1136.                 turned on with the +ALL option on the DOS command
  1137.                 line.
  1138.  
  1139.   Ctrl-O-L  --  Asks for the desired value of the left margin.
  1140.  
  1141.                 The left margin has no effect on the editor
  1142.                 display. It controls the number of extra spaces
  1143.                 inserted at the beginning of lines when printing
  1144.                 using the Ctrl-K-P block print function.
  1145.  
  1146.                 The operation may be canceled with a Ctrl-U or
  1147.                 the Esc key.
  1148.  
  1149.                 The initial value of the left margin is 0.
  1150.  
  1151.   Ctrl-O-R  --  Asks for the desired value of the right line
  1152.                 length.
  1153.  
  1154.                 The right line length is the maximum width of
  1155.                 paragraphs when reformatting with Ctrl-B or Alt-B
  1156.                 or when using automatic word wrap.
  1157.  
  1158.                 The operation may be canceled with a Ctrl-U or
  1159.                 the Esc key.
  1160.  
  1161.                 The initial value of the right line length is 65.
  1162.  
  1163.   Ctrl-O-W  --  Turns the automatic word wrap "on" and "off".
  1164.  
  1165.                 When "on", if any letters are entered beyond the
  1166.                 right margin, all words which extend beyond the
  1167.                 right margin are wrapped down to a new line.
  1168.  
  1169.                 The initial condition of the word wrap is "off".
  1170.  
  1171.   Ctrl-O-N  --  Shows the name of the file being edited,
  1172.                 momentarily, at the top of the window.
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.                              - 20 -
  1182.   Ctrl-O-I  --  Turns the Ins key "on" and "off".
  1183.  
  1184.                 The initial condition is "off", which prevents
  1185.                 accidental presses of the Ins key from setting
  1186.                 the editor into "overwrite" mode.
  1187.  
  1188.   Ctrl-V  or  Ins  --  When the Ins key has been turned on with
  1189.                        Ctrl-O-I keys, this switches the editing
  1190.                        mode back and forth from "insert" mode to
  1191.                        "overwrite" mode.
  1192.  
  1193.                        The initial condition is "insert" mode.
  1194.  
  1195.  
  1196.  
  1197.  
  1198. FILE AND WINDOW CONTROL
  1199.  
  1200.  
  1201.   Ctrl-K-S  or  F2  --  Saves the text file without leaving the
  1202.                         editor.
  1203.  
  1204.                         If there are two windows, only the file
  1205.                         in the active window is saved. The active
  1206.                         window is the window in which the cursor
  1207.                         appears.
  1208.  
  1209.                         Unless the -BAK option has been used on
  1210.                         the DOS command line, the old file is
  1211.                         given a .BAK extension. Any previous file
  1212.                         with the same name and a .BAK extension
  1213.                         is first deleted.
  1214.  
  1215.                 F3  --  Changes the file which is being edited.
  1216.                         You will be asked for the name of the new
  1217.                         file to be edited.
  1218.  
  1219.                         If there are two windows, this changes
  1220.                         the file in the active window only.
  1221.  
  1222.                         The operation may be canceled with a
  1223.                         Ctrl-U or the Esc key.
  1224.  
  1225.                         If a file has been altered without having
  1226.                         been saved, you will be first asked if
  1227.                         you are sure you want to change the file.
  1228.                         In order to perform the operation in this
  1229.                         case without saving your work, you must
  1230.                         answer "y" or "yes". If you want to save
  1231.                         your work before you change the file,
  1232.                         either answer "save", or else give no
  1233.                         answer or some other answer, and then
  1234.                         save the file in the usual way with the
  1235.                         F2 key.
  1236.  
  1237.  
  1238.  
  1239.  
  1240.                              - 21 -
  1241.   Ctrl-K-D          --  Saves the file in the active window, and
  1242.                         then changes the file which is being
  1243.                         edited. You will be asked for the name
  1244.                         of the new file to be edited.
  1245.  
  1246.                         The operation may be canceled with a
  1247.                         Ctrl-U or the Esc key.
  1248.  
  1249.  
  1250.   Ctrl-K-Q  or  F4  --  Quits the editor without saving the file.
  1251.  
  1252.                         If there are two windows, this closes the
  1253.                         active window without saving the file.
  1254.                         The other window becomes the only window.
  1255.  
  1256.                         If a file has been altered without having
  1257.                         been saved, you will be asked if you
  1258.                         are sure you want to quit or to close
  1259.                         the window. In order to perform the
  1260.                         operation in this case without saving
  1261.                         your work, you must answer "y" or "yes".
  1262.                         If you want to save your work before you
  1263.                         quit, either answer "save", or else give
  1264.                         no answer or some other answer, and then
  1265.                         save the file in the usual way with the
  1266.                         F2 key.
  1267.  
  1268.   Ctrl-K-X          --  Saves the file, and then exits the
  1269.                         editor.
  1270.  
  1271.                         If there are two windows, this saves
  1272.                         the file in the active window, and then
  1273.                         closes the window. The other window
  1274.                         becomes the only window.
  1275.  
  1276.   Ctrl-O-K  or  F9  --  If there is only one window, you will be
  1277.                         asked for the name of an additional file
  1278.                         to be edited. This additional file will
  1279.                         be loaded into a second window, which
  1280.                         will become the active window.
  1281.  
  1282.                         If there are two windows, this switches
  1283.                         which window is active. The cursor is
  1284.                         moved from one window to the other. The
  1285.                         position of the cursor in the window
  1286.                         which becomes inactive is remembered.
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.  
  1299.                              - 22 -